Summary

Added support to GetAsync to retrieve an entire structure at once.

Example:

var snapshot = await client.SimVars.GetAsync<MyApp.AircraftSnapshot>();
Console.WriteLine($"Altitude: {snapshot.AltitudeFeet:F0} ft");
Console.WriteLine($"Airspeed: {snapshot.IndicatedAirspeedKnots:F0} kts");
Console.WriteLine($"Title: {snapshot.Title}");

This will populate a struct like:

[StructLayout(LayoutKind.Sequential)]
public struct AircraftSnapshot
{
    /// <summary>
    /// Gets or sets the pressure altitude of the aircraft in feet.
    /// </summary>
    [SimConnect("PLANE ALTITUDE", "feet", SimConnectDataType.Integer32)]
    public int AltitudeFeet;

    /// <summary>
    /// Gets or sets the indicated airspeed in knots.
    /// </summary>
    [SimConnect("AIRSPEED INDICATED", "knots", SimConnectDataType.FloatDouble)]
    public double IndicatedAirspeedKnots;

    /// <summary>
    /// Gets or sets the aircraft title (name).
    /// </summary>
    [SimConnect("TITLE", null, SimConnectDataType.String260, order: 0)]
    public string Title;
}

Changes Made

• Added support to GetAsync to return a struct.
• Added a corresponding test case.

Additional Information

• May need some polish but seems to be working.

• order attribute is not required. If set, attributes with an order are sorted first; otherwise, ordering falls back to struct field order.

• Tried to make attributes optional where possible.

  • Best practice is to set name, unit, and SimConnectDataType explicitly.
  • If any are null, the code attempts to look up the info from the registry.
  • Name is required.

• Overloads the existing GetAsync method.

• [StructLayout(LayoutKind.Sequential)] may not be necessary based on late testing.

Author Information

Discord Username: bstudtma

Checklist

[x] Have you followed the guidelines in our Contributing document?
[x] Have you checked to ensure there aren't other open Pull Requests for the same update/change?